package de.tabuma.lib.contentmanagement.entity;

import java.util.*;

/**
 * <p>Collecting the properties that will be needed to create general content.</p>
 * @author $Author: $
 * @version $Revision: $
 * @since $Date: $
 * @see Content
 */
public class GeneralContent {

    /**
     * Class constructor.
     */
    public GeneralContent() {
        this.paramName = "";
        this.parameter = new Hashtable();
        this.servlet = "";
        this.user = "";
    }

    /**
     * Name of the parameter that will used as parameter to find out what action was called from user
     */
    private String paramName;
    /**
     * Getting  name of the parameter that will used as parameter to find out what action was called from user
     * @return name of the parameter that will used as parameter to find out what action was called from user
     */
    public String getParamName() {
        return paramName;
    }
    /**
     * Setting name of the parameter that will used as parameter to find out what action was called from user
     * @param paramName Name of the parameter that will used as parameter to find out what action was called from user
     */
    public void setParamName(String paramName) {
        this.paramName = paramName;
    }

    /**
     * Name of the servlet in which the ContentController will integrated.
     * @see Content
     */
    public String servlet;
    /**
     * Getting name of the servlet in which the ContentController will integrated.
     * @return name of the servlet in which the ContentController will integrated
     */
    public String getServlet() {
        return servlet;
    }
    /**
     * Setting name of the servlet in which the ContentController will integrated
     * @param servlet name of the servlet in which the ContentController will integrated
     */
    public void setServlet(String servlet) {
        this.servlet = servlet;
    }

    /**
     * Object with general parameter that will generally needed to handle request from servlet surrounded classes
     */
    public Hashtable parameter;
    /**
     * Getting general parameter that will generally needed to handle request from servlet surrounded classes.
     * @return general parameter that will generally needed to handle request from servlet surrounded classes.
     */
    public Hashtable getParameter() {
        return parameter;
    }
    /**
     * Setting general parameter that will generally needed to handle request from servlet surrounded classes
     * @param parameter general parameter that will generally needed to handle request from servlet surrounded classes
     */
    public void setParameter(Hashtable parameter) {
        this.parameter = parameter;
    }

    /**
     * User that will execute all functions
     */
    private String user;
    /**
     * Getting user that will execute all functions.
     * @return user that will execute all functions
     */
    public String getUser() {
        return user;
    }
    /**
     * Setting user that will execute all functions.
     * @param user user that will execute all functions
     */
    public void setUser(String user) {
        this.user = user;
    }
}

